Crate alloy_primitives

source ·
Expand description

alloy-primitives

Primitive types shared by alloy, foundry, revm, and reth.

Types

  • Unsigned integers re-exported from ruint
  • Signed integers, as a wrapper around ruint integers
  • Fixed-size byte arrays via FixedBytes
    • wrap_fixed_bytes!: macro for constructing named fixed bytes types
    • Address, which is a fixed-size byte array of 20 bytes, with EIP-55 and EIP-1191 checksum support
    • fixed_bytes!, address! and other macros to construct the types at compile time

Examples

This library has straightforward, basic, types. Usage is correspondingly simple. Please consult the documentation for more information.

use alloy_primitives::{address, fixed_bytes, Address, FixedBytes, I256, U256};

// FixedBytes
let n: FixedBytes<6> = fixed_bytes!("1234567890ab");
assert_eq!(n, "0x1234567890ab".parse::<FixedBytes<6>>().unwrap());
assert_eq!(n.to_string(), "0x1234567890ab");

// Uint
let mut n: U256 = "42".parse().unwrap();
n += U256::from(10);
assert_eq!(n.to_string(), "52");

// Signed
let mut n: I256 = "-42".parse().unwrap();
n = -n;
assert_eq!(n.to_string(), "42");

// Address
let addr_str = "0x66f9664f97F2b50F62D13eA064982f936dE76657";
let addr: Address = Address::parse_checksummed(addr_str, None).unwrap();
assert_eq!(addr, address!("66f9664f97F2b50F62D13eA064982f936dE76657"));
assert_eq!(addr.to_checksum(None), addr_str);

// Address checksummed with a custom chain id
let addr_str = "0x66F9664f97f2B50F62d13EA064982F936de76657";
let addr: Address = Address::parse_checksummed(addr_str, Some(30)).unwrap();
assert_eq!(addr, address!("66F9664f97f2B50F62d13EA064982F936de76657"));
assert_eq!(addr.to_checksum(Some(30)), addr_str);

Re-exports

Modules

  • aliases
    Type aliases for common primitive types.

Macros

  • address
    Converts a sequence of string literals containing hex-encoded data into a new Address.
  • b64
    Converts a sequence of string literals containing hex-encoded data into a new B64.
  • b128
    Converts a sequence of string literals containing hex-encoded data into a new B128.
  • b256
    Converts a sequence of string literals containing hex-encoded data into a new B256.
  • b512
    Converts a sequence of string literals containing hex-encoded data into a new B512.
  • bloom
    Converts a sequence of string literals containing hex-encoded data into a new Bloom.
  • bytes
    Converts a sequence of string literals containing hex-encoded data into a new Bytes.
  • fixed_bytes
    Converts a sequence of string literals containing hex-encoded data into a new FixedBytes.
  • wrap_fixed_bytes
    Wrap a fixed-size byte array in a newtype, delegating all methods to the underlying crate::FixedBytes.

Structs

  • Address
    An Ethereum address, 20 bytes in length.
  • BigIntConversionError
    The error type that is returned when conversion to or from a integer fails.
  • Bloom
    Ethereum 256 byte bloom filter.
  • Bytes
    Wrapper type around Bytes to deserialize/serialize “0x” prefixed ethereum hex strings.
  • FixedBytes
    A byte array of fixed length ([u8; N]).
  • Function
    An Ethereum ABI function pointer, 24 bytes in length.
  • Signed
    Signed integer wrapping a ruint::Uint.

Enums

Constants

Functions

Type Definitions